home *** CD-ROM | disk | FTP | other *** search
/ Aminet 40 / Aminet 40 (2000)(Schatztruhe)[!][Dec 2000].iso / Aminet / util / sys / StringSnip.readme < prev    next >
Text File  |  2000-11-01  |  11KB  |  333 lines
  1. Short:    Much better editing features in string gadgets
  2. Author:   thor@math.tu-berlin.de (Thomas Richter)
  3. Uploader: thor@math.tu-berlin.de
  4. Version:  2.05
  5. Type:     util/sys
  6. Requires: Os 2.05, optionally ViNCEd.
  7.  
  8. _____________________________________________________________________________
  9.  
  10. New in release 2.05:
  11.  
  12.     - The possible TAB expansions are now sorted alphabetically.
  13.     - Note that in case you want both the functions "Insert 
  14.       Clipboard" and "Replace by Clipboard", the keyboard strings
  15.       PASTE=RAmiga v and PASTE=RAmiga V must be defined *both* and
  16.       must be defined to both the same ViNCEd function.
  17.  
  18. New in release 2.04:
  19.  
  20.     - Due to some unfortune, an internal structure appeared on an odd
  21.       address which caused a crash on 68000 and 68010 based systems.
  22.       Nothing else changed.
  23.  
  24. New in release 2.03:
  25.  
  26.     - Fixed a possible incompatibility of Amiga-V that could have
  27.       resulted in inserting a string twice if the application edit
  28.       hook is able to parse this key as well.
  29.  
  30. New in release 2.02:
  31.  
  32.     - The NumLock function was erraneously bound to Alt-Ü on german
  33.       keyboards. Never thrust a Data-Becker book, especially when
  34.       looking up key-codes.
  35.  
  36. New in release 2.01.1:
  37.  
  38.     - Included a sample preferences file for those people that don't
  39.       read ReadMes. (-;
  40.  
  41. New in release 2.01:
  42.  
  43.     - Almost a complete rewrite, fully configurable with ViNCEd style
  44.       preferences (vnc.library required).
  45.     - Includes now TAB expansions and much more editor commands.
  46. _____________________________________________________________________________
  47.  
  48.  
  49. The following table shows the default configuration for string gadget hooks:
  50.  
  51. Alt+Cursor keys:    Move to beginning of next/previous word
  52. Alt+Ctrl+Cursor keys:    Move to beginning of next/previous path component
  53. Shift+Cursor keys:    Move to start/end of the contents.
  54. Alt+Cursor keys:    ditto.
  55. Alt+Del:        Clear the contents.
  56. Shift+Del:        ditto.
  57. ALT+Backspace:        Erase to the beginning of the word under the cursor
  58. Shift+Alt+Del:        Erase text behind the cursor
  59. Shift+Alt+BS:        Erase text before the cursor position
  60. Amiga+X:        Cut the contents of the gadget to the clipboard
  61. Amiga+C:        Copy the contents to the clipboard
  62. Amiga+V:        Insert the clipboard contents into the gadget
  63. Shift+Amiga+V:        Replace the string gadget contents by the clipboard
  64. Aniga+Q:        Undo-operation
  65. Ctrl+Tab:        TAB expansion
  66. Ctrl+Shift+Tab:        TAB expansion backwards
  67. Commodore-key:        Turn off the extended editing features temporary
  68.  
  69.  
  70. The configuration is, however, fully adjustable with the SetVNC program
  71. of the "ViNCEd" package, see below for details.
  72.  
  73. The TAB expansion is a "cut down" version of the ViNCEd style expansion
  74. mechanism without a double-TAB requester, without the complete command
  75. path search and without a TAB expansion cache.
  76. Please note that string gadget does not come with a "natural" directory the 
  77. TAB expansion should search in, hence the path to be expanded must be either
  78. absolute or relative to the boot volume, i.e. SYS:
  79.  
  80. (This file is actually a part of the ViNCEd distribution. See 
  81. util/shell/ViNCEd.lha for the complete archive).
  82.  
  83.  
  84. Installation:
  85.     Copy to your C: drawer.
  86.  
  87.     StringSnip install    To install the extended editing features
  88.     StringSnip remove    To remove it again.
  89.  
  90. Additionally:    
  91.     Copy the demo prefs file below to ENVARC:StringSnip.prefs and 
  92.     add the line
  93.  
  94.     StringSnip PREFS ENV:StringSnip.prefs INSTALL
  95. _____________________________________________________________________________
  96.  
  97. Extended options, full synopsis:
  98.  
  99. StringSnip INSTALL/S,REMOVE/S,PREFS/K,HELP/S
  100.  
  101.  
  102. INSTALL/S            Installs the enhanced string edit hook
  103.                 or replaces a previously installed 
  104.                 "StringSnip" copy.
  105.                 This is the default operation.
  106.  
  107. REMOVE/S            Remove the StringSnip hook.
  108.  
  109. PREFS/K                Specifies a file name where the preferences
  110.                 should be taken from. This is a text based
  111.                 ViNCEd-compatible preferences file. It
  112.                 should be created by the "SetVNC" program
  113.                 and should be placed somehwere in the ENV:
  114.                 drawer.
  115.                 THIS OPTION REQUIRES the vnc.library, i.e.
  116.                 ViNCEd must have been installed.
  117.  
  118. HELP/S                Prints a tiny overview about the command line
  119.                 options.
  120. _____________________________________________________________________________
  121.  
  122. The preferences file: 
  123.  
  124. It is recommended that you use the "SetVNC" program of the ViNCEd package
  125. to generate this file, as the vnc.library is required anyways to read it.
  126.  
  127. As last resort, an ASCII editor is enough to edit this file, though.
  128.  
  129. The file is a listing of options, followed by an "=" ("equals") sign,
  130. followed by the value you want to set the option to. This must be "on"
  131. or "off" for boolean options, a number for numerical or a key specification
  132. for the keyboard configuration options. Commands must be introduced by a
  133. semicolon.
  134.  
  135. Here's a list of the options that are meaningfull to StringSnip. The lines
  136. below could be cut out and written directly to a file, for example to
  137. ENVARC:StringSnip.prefs.
  138.  
  139. ___________cut here__________________________________________________________
  140.  
  141. WRAP=off        
  142. ;whether the TAB expansion wraps around or not.
  143.  
  144. ;TAB expansion settings:
  145. ;These are priorities how the list of found nodes are sorted and in
  146. ;which order they appear. The list of found matches can be cycled thru
  147. ;with the TAB expansion keys, as in ViNCEd.
  148.  
  149. TAB_FILE_PRI=0        
  150. ;priority of non-executable non-script files
  151. TAB_EXEC_PRI=2        
  152. ;priority of executables.
  153. TAB_SCRIPT_PRI=1    
  154. ;priority of script files.
  155. TAB_INFO_PRI=-10    
  156. ;priority of icons
  157. TAB_DEVICE_PRI=-2    
  158. ;of devices
  159. TAB_ASSIGN_PRI=-2    
  160. ;of assigns (logical devices)
  161. TAB_VOLUME_PRI=-2    
  162. ;of volume names
  163. TAB_DIRECTORY_PRI=3    
  164. ;of directories
  165. TAB_FULLEXPAND=off    
  166. ;should the first TAB expand the file completely?
  167.  
  168.  
  169. ;Keyboard:
  170. ;These are one or more qualifiers, i.e.
  171. ; Alt, Shift for either shift or alt key, RAmiga, LAmiga, RShift, LShift,
  172. ; RAlt, RAlt for the right/left modifier keys, "Num" if numlock is "on".
  173. ; The numlock is a special modifier that is toggled by an additional key
  174. ; to be set up here, it is completely unrelated to the "numeric keypad"
  175. ;and a key name, as "Left" "Right" for the cursor keys or
  176. ;a keyboard code, or an ASCII value enclosed in single quotes if the
  177. ;key should be matched on an ASCII string and not on a physical key.
  178. ;Details about this again in the ViNCEd guide.
  179. ;
  180. CURSOR_LEFT=Left
  181. CURSOR_RIGHT=Right        
  182. ;guess what...
  183. HALF_SCREEN_LEFT=Shift Left    
  184. ;moves one string gadget width
  185. HALF_SCREEN_RIGHT=Shift Right    
  186. ;to the left/right (not used by default)
  187. TO_LEFT_BORDER=Ctrl Left
  188. TO_RIGHT_BORDER=Ctrl Right    
  189. ;moves to the boundary
  190. PREV_WORD=Alt Left
  191. NEXT_WORD=Alt Right        
  192. ;moves word-wise
  193. PREV_COMPONENT=Ctrl Alt Left
  194. NEXT_COMPONENT=Ctrl Alt Right    
  195. ;moves path-component-wise
  196. CURSOR_LEFT=Num Num4
  197. CURSOR_RIGHT=Num Num6        
  198. ;more than one definition is allowed!
  199. TO_LEFT_BORDER=Ctrl Left
  200. TO_RIGHT_BORDER=Ctrl Right
  201. SEND_INPUTS=Return        
  202. ;completes the input
  203. INSERT_^J=Shift Alt Return    
  204. ;inserts a Ctrl-J.
  205. TAB_FORWARDS=Tab
  206. TAB_BACKWARDS=Shift Tab        
  207. ;TAB cycling
  208. EXPAND_PATH=Ctrl Tab
  209. EXPAND_BACKWARDS=Ctrl Shift Tab    
  210. ;TAB expansion
  211. DELETE_FORWARDS=Del        
  212. ;the "Delete" function
  213. DELETE_BACKWARDS=Backspace    
  214. ;the "Backspace" function
  215. DELETE_FULL_LINE=Shift Del    
  216. ;delete all
  217. DELETE_WORD_FWDS=Shift Backspace
  218. DELETE_WORD_BKWDS=Alt Backspace    
  219. ;one word, backwards
  220. DELETE_COMPONENT_FWDS=Ctrl Alt Del
  221. DELETE_COMPONENT_BKWDS=Ctrl Alt Backspace
  222. DELETE_END_OF_LINE=Shift Alt Del
  223. DELETE_START_OF_LINE=Shift Alt Backspace
  224. ;the next are the standard clipboard functions
  225. CUT=RAmiga x            
  226. COPY=RAmiga c
  227. PASTE=RAmiga v
  228. TOGGLE_NUMLOCK=Alt Num[        
  229. ;Num[ is the '[' key on the numpad, this toggles the NumLock qualifier.
  230. YANK=RAmiga q            
  231. ;this is the intuition style "undo"
  232. HELP=Help            
  233. ;the HELP function, if used by the program
  234. INSERT_CSI=Alt Esc        
  235. ;inserts 0x9B
  236. INSERT_ESC=Shift Esc        
  237. ;inserts 0x1B
  238.  
  239. _____________________________________________________________________________
  240.  
  241.                          The THOR-Software Licence (v2, 24th June 1998)
  242.  
  243.  
  244. This License applies to the computer program known as "StringSnip".
  245. The "Program", below, refers to such program. The "Archive" refers to the 
  246. package of distribution, as prepared by the author of the Program, 
  247. Thomas Richter. Each licensee is addressed as "you".
  248.  
  249.  
  250.  
  251. The Program and the data in the archive are freely distributable
  252. under the restrictions stated below, but are also Copyright (c)
  253. Thomas Richter.
  254.  
  255. Distribution of the Program, the Archive and the data in the Archive by a
  256. commercial organization without written permission from the author to any
  257. third party is prohibited if any payment is made in connection with such
  258. distribution, whether directly (as in payment for a copy of the Program) or
  259. indirectly (as in payment for some service related to the Program, or
  260. payment for some product or service that includes a copy of the Program
  261. "without charge"; these are only examples, and not an exhaustive enumeration
  262. of prohibited activities).
  263.  
  264.  
  265. However, the following methods of distribution
  266. involving payment shall not in and of themselves be a violation of this
  267. restriction:
  268.  
  269.  
  270. (i) Posting the Program on a public access information storage and
  271. retrieval service for which a fee is received for retrieving information
  272. (such as an on-line service), provided that the fee is not
  273. content-dependent (i.e., the fee would be the same for retrieving the same
  274. volume of information consisting of random data).
  275.  
  276.  
  277. (ii) Distributing the Program on a CD-ROM, provided that
  278.  
  279. a) the Archive is reproduced entirely and verbatim on such CD-ROM, including
  280. especially this licence agreement;
  281.  
  282. b) the CD-ROM is made available to the public for a nominal fee only,
  283.  
  284. c) a copy of the CD is made available to the author for free except for
  285. shipment costs, and
  286.  
  287. d) provided further that all information on such CD-ROM is redistributable
  288. for non-commercial purposes without charge.
  289.  
  290.  
  291. Redistribution of a modified version of the Archive, the Program or the
  292. contents of the Archive is prohibited in any way, by any organization,
  293. regardless whether commercial or non-commercial. Everything must be kept
  294. together, in original and unmodified form.
  295.  
  296.  
  297.  
  298.  
  299. Limitations.
  300.  
  301.  
  302. THE PROGRAM IS PROVIDED TO YOU "AS IS", WITHOUT WARRANTY. THERE IS NO
  303. WARRANTY FOR THE PROGRAM, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  304. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  305. PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE ENTIRE
  306. RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
  307. THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  308. SERVICING, REPAIR OR CORRECTION.
  309.  
  310.  
  311. IF YOU DO NOT ACCEPT THIS LICENCE, YOU MUST DELETE THE PROGRAM, THE ARCHIVE
  312. AND ALL DATA OF THIS ARCHIVE FROM YOUR STORAGE SYSTEM. YOU ACCEPT THIS
  313. LICENCE BY USING OR REDISTRIBUTING THE PROGRAM.
  314.  
  315.  
  316.                                                         Thomas Richter
  317.  
  318. _____________________________________________________________________________
  319.  
  320. Thomas,
  321.     September 2000
  322.  
  323.  
  324. ============================= Archive contents =============================
  325.  
  326. Original  Packed Ratio    Date     Time    Name
  327. -------- ------- ----- --------- --------  -------------
  328.     9800    5930 39.4% 10-Sep-00 14:49:10 +StringSnip
  329.     2981    1426 52.1% 23-Jan-99 18:44:30 +StringSnip.prefs
  330.    10886    4537 58.3% 10-Sep-00 14:57:32 +StringSnip.readme
  331. -------- ------- ----- --------- --------
  332.    23667   11893 49.7% 18-Sep-100 20:16:06   3 files
  333.